'.\" t
.TH "clstart.xml" "1M" "Jun 30, 2005" "1\&.0\&.0"
.SH NAME
clstart.xml \- Linuxha.net RC Startup Config File

.SH SYNOPSIS
Definition of Linuxha.net RC Startup Config File

A sample configuration file may look similar to the following:

.TS
l.
<?xml version="1.0" standalone="yes"?>
<clstart_config>
    <allow_single_node>yes|no</allow_single_node>
    <background_startup>yes|no</background_startup>
    <join_existing_cluster>yes|no</join_existing_cluster>
    <autostart_apps>yes|no</autostart_apps>
    <timeout>NNN</timeout>
</clstart_config>
.TE

This configuration file, which must exist in the /etc/cluster
directory, is used by the \fIclstartup(1M)\fP utility,
to define how and if a cluster is formed when one or both
servers in the cluster are booted.

Whether the administrator wishes to use an automated cluster
start-up really depends on the application. For environments
that want high availability though often have systems that
are not attended (it does happen quite a lot!), then this 
utility combined with automatic hardware reboot, or boot on Lan,
it is recommended.

The utility itself alters it's behaviour based on the 
contents of this (simple) XML file. Each element is now
described in a little more detail.

.TP 10
.B allow_single_node
If set to "yes" then it means that when a cluster is
being formed (since it does not exist currently), then
allow a single node to form the cluster after the 
time-out period.

If this option is not set it defaults to "no". In such
cases if the other node does not attempt to join the
cluster in the time-out period defined for the cluster,
then formation will be aborted.
.TP
.B background_startup
Not supported as yet - in the future will cause the
formation of the cluster to run as a background task and
thus not hold up any following Run Control scripts.
.TP
.B join_existing_cluster
If a node is booted and the cluster is already running 
on the other node, then this attribute determines what
the new node should do.

Unsupprisingly if it is set to "no" it does not attempt
to join the cluster, where-as when set to "yes" it does.
.TP
.B autostart_apps
If set to "yes" and node formation rather than joining is
being performed then the applications will be started.
Under these conditions the applications started are those
defined with the "auto start" attribute - rather than
just all applications known to the cluster.

All such commands are run from the primary node - hence
care should be taken to make use of the "preferred_node"
to ensure all applications are not started on the 
same node (unless that is particularly required).
.TP
.B timeout
If defined this will override the defined timeout 
in the cluster configuration file. Can be useful since
unless the script appears near the end of the run-control
sequence the overall boot-time can be lengthy if the other
node is not available.

.SH SEE ALSO
.TS
l.
lemsctl(1M)    - Lems daemon controlller program
lems.pl(1M)    - Lems daemon
appconf.xml(5) - Configuration of an application used by the cluster
procmon.xml(5) - Configuration file format for Lems process monitor
clconf.xml(5)  - Cluster configuration file format
lems.xml(5)    - Lems Configuration file format
.TE

.SH AVAILABILITY
This software is freely available from the Linuxha.net website - please see
http://linuxha.net/index.pl?ARGS=findproject:linuxha for more details.

.SH WARRANTY
This is Open Source Software is per the GNU GPL. It is free to use and
distribute but \fIcomes with no warranty whatsoever\fP. For more information
on the license please see \fBwww.gnu.org/copyleft/gpl.html\fP.

